/*
 * All rights Reserved, Designed By cloudland Copyright(C) 2010-2014
 *
 * fileName:  IDocumentDesc.java
 * author:  lei
 * Company:  Cloudland Studio
 * Createdate:  2013-9-19 下午10:00:46
 *   
 * Modification  History:
 *     Date           Author        Version        
 * -------------------------------------------
 * 2013-9-19          Lei            1.0        
 *
 * Why & What is modified:
 * 1.0: 文件创建
 */
package org.cloudland.search.config;

import java.io.File;

import org.apache.lucene.analysis.Analyzer;

 /**
 * <pre> 
 * 获取搜索配置文件中对搜索相关限制的配置，
 * 如：索引文件存放位置，使用的分词器实现类等
 * </pre>
 * @ClassName  IDocumentDesc
 * @author  lei
 * @version  %I%, %G%
 * @see  
 * @since   JDK1.6
 *
 */
public interface IDocumentDesc {

	/**
     * 
     *@description: 获取配置的分词实现对象
     *@return 分词对象
     */
    public Analyzer getSearchAnalyzer();
    
    /**
     * 
     *@description: 获取索引文件的存储路径
     *@return 索引文件的存储路径对象
     */
    public File getIndexPosition();
    
    /**
     * 
     *@description: 获取索引配置服务的名称，不同平台配置使用不同的服务名称
     *@return 配置服务的名称
     */
    public String getSearchName();
    
    /**
     * 
     *@description: 获取配置的索引域描述
     *@return 索引域描述数组
     */
    public IFieldDesc[] getFieldDesc();
    
}
